Open
Conversation
amroakmal
added
docs
amroakmal
changed the title
amroakmal
force-pushed
the
785-benchpark-analysis
branch
11 times, most recently
from
d079933 to
a91094b
Compare
pearce8
requested changes
May 25, 2025
Collaborator
pearce8
left a comment
pearce8
left a comment
There was a problem hiding this comment.
Please fix the spelling which makes docs build fail.
Collaborator
Author
@pearce8 : Done, Dr. Olga, and rebased too. |
amroakmal
force-pushed
the
785-benchpark-analysis
branch
from
39b7b55 to
eb6aac3
Compare
amroakmal
changed the title
michaelmckinsey1
requested changes
May 29, 2025
Collaborator
michaelmckinsey1
left a comment
michaelmckinsey1
left a comment
There was a problem hiding this comment.
Some content review and suggestions
| :maxdepth: 1 | ||
| :caption: Developer Docs | ||
|
|
||
| developer-docs/benchpark-developer-docs.rst |
Collaborator
There was a problem hiding this comment.
I would advise to split
* `Core Concepts and Patterns`_ - Understanding Variants, Consistent Flow, and Modifiers
* `Benchpark Command Workflow`_ - Step-by-step execution of key Benchpark commands
* `Debugging Benchpark with VSCode`_ - Setting up debugging environment for development
these into 3 pages here instead of 1 single page.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Based on what I learned and my understanding so far, this issue tracks new insights into Benchpark (BP) to deepen understanding of its execution flow. It also serves as developer documentation by offering more detailed information than the main docs.
Fixes: #785
Summary for what's introduced: